Skip to content

Replace redundant sections with link to the typing documentation #7594

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 5 commits into from

Conversation

srittau
Copy link
Collaborator

@srittau srittau commented Apr 5, 2022

No description provided.

@JelleZijlstra JelleZijlstra self-requested a review April 5, 2022 13:58
Copy link
Member

@JelleZijlstra JelleZijlstra left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this removes too much. I'm on board with shortening this text, but some parts are typeshed-specific and should be kept, and others aren't yet covered in the typing docs.

A few guidelines for protocol names below. In cases that don't fall
into any of those categories, use your best judgement.

* Use plain names for protocols that represent a clear concept
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This isn't in the linked doc

context manager is meant to be subclassed, pick `bool | None`.
See https://github.com/python/mypy/issues/7214 for more details.

`__enter__` methods and other methods that return instances of the
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The typing docs don't mention this

be used in typeshed as soon as the PEP has been accepted and implemented
and most type checkers support the new feature.

Accepted features that *cannot* yet be used in typeshed include:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this list is still useful, and it makes sense to keep it in typeshed because it's specifically about this repo's policies.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Whoops, I kind of forgot about this PR.

Maybe it's best to link to https://github.com/python/typeshed/issues?q=is%3Aissue+is%3Aopen+label%3Afeature-tracker, instead of listing the missing features? The issues are more likely to be kept up-to-date than the list in CONTRIBUTING.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, sounds good

Copy link
Member

@AlexWaygood AlexWaygood May 21, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could also consider using a meta-issue tracker to track the issue trackers. The advantage of using an issue to track the issue trackers is that items will automatically be ticked off as completed if issue trackers on the bullet-pointed list are closed. We could link to the meta-issue tracker from CONTRIBUTING.md and pin it on the issue tracker.

@srittau srittau marked this pull request as draft May 21, 2022 15:46
@Avasam
Copy link
Collaborator

Avasam commented Dec 7, 2023

Are there parts of this we still want? Shortening CONTRIBUTING.md seems worthwhile, but a lot as changed since then. (and this is the oldest + least recently updated typeshed PR ! )

@srittau srittau closed this Dec 8, 2023
@srittau srittau deleted the link-to-typing-docs branch January 16, 2025 10:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants